Skip to content

DOC-18329: typedoc indexing improvements#6817

Merged
jpmarceau merged 14 commits intomainfrom
DOC-18329
Dec 19, 2025
Merged

DOC-18329: typedoc indexing improvements#6817
jpmarceau merged 14 commits intomainfrom
DOC-18329

Conversation

@jpmarceau
Copy link
Contributor

@jpmarceau jpmarceau commented Dec 16, 2025

https://coveord.atlassian.net/browse/DOC-18329

Two changes meant to improve the ranking score of typedoc pages, which is currently quite poor.

  1. Change @coveo/headless to Coveo Headless in the title. This way, the Coveo index can match Headless with queries. It also more closely matches the rest of the site.
  2. Split the function/object name from reference titles and append reference (e.g., buildAttachedResults becomes build attached results reference). Then, put that into a new meta tag I'll use for title indexing later, making it free text searchable. The rationale is that this way, we can return relevant reference pages when people query functions/object names non concatenated (e.g., build attached results headless reference). Here's what the tag looks like:
Screenshot 2025-12-16 at 2 41 59 PM

@github-actions
Copy link

github-actions bot commented Dec 16, 2025

🔗 Scratch Orgs ready to test this PR:

@jpmarceau jpmarceau added this pull request to the merge queue Dec 19, 2025
Merged via the queue into main with commit 14213f1 Dec 19, 2025
106 checks passed
@jpmarceau jpmarceau deleted the DOC-18329 branch December 19, 2025 16:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants